home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_3 / emacdg16.lha / EMACSDLG.DOC < prev    next >
Text File  |  1994-10-21  |  34KB  |  1,208 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.          EEEEE                DDDD   L      GGG
  9.          E                D    D  L     G   G
  10.          E     mmmmm  aaa cccc ssss D     D L     G
  11.          EEEE  m m m    a c    s    D     D L     G GGG
  12.          E     m m m aaaa c    ssss D     D L     G   G
  13.          E     m m m a    a c      s D    D  L     G   G
  14.          EEEEE m   m aaaa cccc ssss DDDD   LLLLL  GGGG
  15.  
  16.  
  17.              An    Emacs-based Message Editor for DLG
  18.  
  19.                Version 1.6 - 21-Oct-1994
  20.  
  21.  
  22.  
  23.            Alan    Bland              Quarter Note
  24.            442 Seven Hills Drive    Fidonet 1:104/121
  25.            Boulder, CO 80302          (303)939-9923
  26.            USA
  27.  
  28.  
  29.  
  30.       1.  DISTRIBUTION RIGHTS
  31.  
  32.       EmacsDLG is based on MicroEMACS 3.11 (C)Copyright 1988,
  33.       1989,    1990, 1991 by Daniel M.    Lawrence.  EmacsDLG extensions
  34.       to MicroEmacs    are (C)Copyright 1993 by Alan Bland.  EmacsDLG
  35.       can be copied    and distributed    freely for any non-commercial
  36.       purposes.  Distributors of public domain software
  37.       collections may redistribute EmacsDLG    for media costs    only.
  38.  
  39.       In its unregistered mode, EmacsDLG provides all the
  40.       functions of any good    full-screen BBS    message    editor,    and
  41.       you are welcome to use it for    as long    as you wish without
  42.       feeling obliged to register.    Should you choose to register
  43.       EmacsDLG, you    will receive a keyfile that will allow you to
  44.       use the extra    functions, such    as:
  45.  
  46.          - EmacsFIG, a Gadtools-based program that lets you
  47.            customize many aspects of your EmacsDLG configuration:
  48.            colors, quote header, quote prefix, most    text strings.
  49.            You will    even be    able to    install    multiple
  50.            configurations so you can run EmacsDLG in several
  51.            different languages!  The EmacsFIG program is included
  52.            in this package,    but EmacsDLG will not use your
  53.            configuration changes without a keyfile.
  54.  
  55.          - Interfaces to use an AREXX spelling checker and any
  56.            compatible fortune cookie generator.
  57.  
  58.          - Individual customization    per-user via the EmacsOpts
  59.            external    program.
  60.  
  61.          - Full integration    with the Hack &    Slash messaging
  62.            system.
  63.  
  64.  
  65.  
  66.  
  67.       EmacsDLG 1.6                       21-Oct-1994
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.                      - 2 -
  76.  
  77.  
  78.  
  79.       See the enclosed REGISTER.TXT    registration form for details
  80.       on how to register.  If you are the author of    a shareware
  81.       program for DLG, I will trade    registrations with you.
  82.       Contact me with your proposal.
  83.  
  84.       My other programs include the    popular    Wanderer and Al's
  85.       Blackjack Casino CLI doors, the MenuThing menu editing
  86.       assistant for    DLG, The YaHoo and HeyMon monitoring programs
  87.       for DLG, and various other teeny BBS utilities.  You can
  88.       always file request the latest versions of my    programs from
  89.       1:104/121 by the magic names EMACSDLG, WANDERER, CASINO,
  90.       MENUTHING, and YAHOO.
  91.  
  92.  
  93.  
  94.  
  95.       2.  HERITAGE
  96.  
  97.       Once upon a time I ran a Xenolink BBS.  Xenolink had a very
  98.       nice full-screen editor called X-Ed, but X-Ed    broke during
  99.       one particular revision of Xenolink.    X-Ed's author had
  100.       vanished, leaving Xenolink without a functional full-screen
  101.       editor.  To remedy this situation, I scrounged the source to
  102.       MicroEmacs and started hacking.  About the time I released
  103.       the first version of EmacsXL,    X-Ed's author reappeared, so
  104.       Xenolink was fortunate enough    to have    two great full-screen
  105.       editors.  EmacsXL went through four major releases during
  106.       1992 to become the most stable and popular Xenolink editor.
  107.  
  108.       Then I switched to DLG (and lived happily ever after?) and
  109.       promptly created EmacsDLG.  EmacsDLG will appeal to your
  110.       users    who also call Xenolink boards.    More importantly, it
  111.       will appeal to users who are familiar    with any of the    Emacs
  112.       editors available on nearly every computer platform.
  113.  
  114.  
  115.  
  116.  
  117.       3.  INSTALLATION
  118.  
  119.       To install EmacsDLG on your system for the first time,
  120.       perform the following    steps:
  121.  
  122.         a.    Copy the EmacsDLG and EmacsFIG executables into    your
  123.         DLG: directory (or anywhere else you wish).
  124.  
  125.         b.    Copy the EmacsDLG.HLP and EmacsOpts files into your
  126.         DLGconfig:Misc directory.
  127.  
  128.         c.    If you are registered, copy your personalized
  129.         EmacsDLG.KEY file into your DLGconfig:Misc directory.
  130.         Then run EmacsFIG from that directory to perform any
  131.         customization you wish and SAVE    the results.
  132.  
  133.         d.    Install    the reqtools.library into your LIBS:
  134.         directory.  You    probably already have reqtools.library
  135.  
  136.  
  137.  
  138.       EmacsDLG 1.6                       21-Oct-1994
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.                      - 3 -
  147.  
  148.  
  149.  
  150.         from some other    utility    that you use.  If you don't
  151.         already    have it, you should be able to obtain it from
  152.         any Amiga BBS, or you can file request it from
  153.         1:104/121 by the magic name REQTOOLS.  The
  154.         reqtools.library is used for a file requester for
  155.         local port file    operations.  If    you do not install
  156.         reqtools.library, you will not be able to use the file
  157.         requester.
  158.  
  159.         e.    Create an entry    in your    DLG Editor menu    for EmacsDLG.
  160.         In the description, you    should mention that it is an
  161.         Emacs-based editor and that it works for IBM ANSI and
  162.         Amiga ANSI terminals.  Here are    the settings to    use.
  163.         The flag settings are very important to    the correct
  164.         operation of EmacsDLG:
  165.  
  166.              Name:  EMACS Full Screen Editor (ANSI IBM or Amiga)
  167.  
  168.              Call string:  DLG:EmacsDLG    ~b ~h ~r %uname    %port
  169.  
  170.              CTRL-c breaking:  No
  171.              CTRL-d breaking:  Yes
  172.              Return/linefeed:  Yes
  173.                 Echo:  No
  174.              Process killing:  Yes
  175.             Kill pending:  No
  176.               Pass-thru    mode:  No
  177.                  Pausing:  No
  178.                 Raw    mode:  Yes
  179.                 Timeouts:  Yes
  180.                Verbose pause:  No
  181.                Line freezing:  Yes
  182.  
  183.       That's all you need to do!  EmacsDLG is now ready to be used
  184.       by you and your callers!
  185.  
  186.  
  187.       3.1  FILE LOCATIONS
  188.  
  189.       After    you have properly installed EmacsDLG, you will see the
  190.       following files.  If something does not work properly, check
  191.       to make sure the files are in    their proper locations.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.       EmacsDLG 1.6                       21-Oct-1994
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.                      - 4 -
  218.  
  219.  
  220.  
  221.       _______________________________________________________
  222.       |File           Location                 |
  223.       |______________________________________________________|
  224.       | EmacsDLG       DLG:    (or elsewhere if you wish)     |
  225.       | EmacsFIG       DLG:    (or anywhere in    your PATH)     |
  226.       | EmacsDLG.HLP   DLGconfig:misc             |
  227.       | EmacsOpts       DLGconfig:misc             |
  228.       |*EmacsDLG.OPT   USER:User_Name (created by EmacsOpts) |
  229.       |*EmacsDLG.KEY   DLGconfig:misc             |
  230.       |*EmacsDLG.CFG   DLGconfig:misc (created by EmacsFIG)     |
  231.       |______________________________________________________|
  232.       |* Only for registered versions             |
  233.       |______________________________________________________|
  234.  
  235.  
  236.  
  237.       3.2  UPGRADING FROM PREVIOUS VERSIONS
  238.  
  239.       If you already have a    version    of EmacsDLG installed, you
  240.       should make backup copies of the files and then copy the new
  241.       files    over the old ones.  Registered users will then need to
  242.       perform an upgrade step to convert their EmacsDLG.CFG    file
  243.       from the old format to the new format.  To perform the
  244.       conversion, simply execute the following commands:
  245.  
  246.            cd DLGconfig:misc   (or wherever    you keep EmacsDLG.CFG)
  247.            run EmacsFIG
  248.            --> click on the    SAVE gadget
  249.  
  250.       EmacsFIG will    automatically convert the old format
  251.       configuration    file to    the new    format.     If you    fail to
  252.       perform this step, EmacsDLG will exit    with an    error message
  253.       when you try to run it.
  254.  
  255.  
  256.       3.3  MULTIPLE    CONFIGURATIONS
  257.  
  258.       You may choose to install multiple EmacsDLG configurations.
  259.       The most likely reason would be to have different setups for
  260.       different languages, but you might also want to use
  261.       different spelling checkers or different fortune cookie
  262.       programs.
  263.  
  264.       To setup a second EmacsDLG configuration, perform the
  265.       following steps:
  266.  
  267.         a.    Create a directory, say    "doors:EmacsToo".
  268.  
  269.         b.    Copy the EmacsDLG.HLP file into    the directory, and use
  270.         any text editor    to edit    it as desired.
  271.  
  272.         c.    Copy the EmacsOpts program into    the directory.
  273.         Otherwise the per-user customization command will not
  274.         work.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.       EmacsDLG 1.6                       21-Oct-1994
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                      - 5 -
  289.  
  290.  
  291.  
  292.         d.    Run EmacsFIG in    this directory and save    any desired
  293.         changes.  NOTE:    You must CD to this directory before
  294.         running    EmacsFIG!
  295.  
  296.         e.    Add a new editor entry,    but use    the following call
  297.         string:
  298.  
  299.              DLG:EmacsDLG ~b ~h    ~r %uname %port    doors:EmacsToo/
  300.  
  301.         NOTE: The directory path MUST have a trailing slash or
  302.         colon.
  303.  
  304.       EmacsDLG will    look in    the specified directory    for its
  305.       configuration    files instead of in the    default
  306.       DLGconfig:Misc/.
  307.  
  308.  
  309.  
  310.  
  311.       4.  USER SETUP
  312.  
  313.       EmacsDLG has been extensively    tested with Terminus 16-color
  314.       ANSI mode using an IBM font.    Any terminal package that
  315.       performs similar IBM ANSI emulations should perform just as
  316.       well.
  317.  
  318.       Several settings in the user's DLG Options menu affect how
  319.       EmacsDLG operates:
  320.  
  321.          - The ANSI    Color setting determines whether EmacsDLG
  322.            displays    color or monochrome.
  323.  
  324.          - EmacsDLG    adapts to the users screen width and length.
  325.  
  326.          - The ANSI    Screen Positioning setting determines whether
  327.            EmacsDLG    uses the smart insert/delete character
  328.            operations.  If Screen Positioning is ON, EmacsDLG uses
  329.            those operations    for fast screen    updates.  If Screen
  330.            Positioning is OFF, EmacsDLG avoids those sequences,
  331.            allowing    it to work great with most IBM terminal
  332.            programs.
  333.  
  334.       Below    is a list of recommended settings for several IBM
  335.       terminal programs that have a    history    of not working well
  336.       with DLG.  You will find EmacsDLG works very well when the
  337.       settings are correct.
  338.  
  339.          - QMODEM: Set QMODEM for ANSI emulation, Keypad emulation
  340.            ON, Numlock ON, and strict color    ON.  Set DLG for ANSI
  341.            screen positioning OFF.
  342.  
  343.          - PROCOMM:     Set PROCOMM for ANSI-BBS emulation.  Set DLG
  344.            for ANSI    screen positioning OFF.
  345.  
  346.       Regular users    of MicroEmacs, GNUemacs, EmacsXL, or other
  347.       variants of Emacs will feel quite at home with EmacsDLG.
  348.  
  349.  
  350.  
  351.       EmacsDLG 1.6                       21-Oct-1994
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                      - 6 -
  360.  
  361.  
  362.  
  363.       Many commands    have been removed or restricted    to prevent
  364.       users    from accidentally or otherwise gaining access to files
  365.       on your system.  The supplied    help file lists    the most
  366.       common commands, but other popular Emacs commands also work.
  367.  
  368.       Registered owners will receive a key that unlocks several
  369.       additional features for your users:  per-user    customization
  370.       of colors and    quote greetings, spelling checker, and more!
  371.  
  372.  
  373.  
  374.  
  375.       5.  SYSOP FILE OPERATIONS
  376.  
  377.       Several additional commands are available to users with
  378.       access level 255.  The access    level is configurable for
  379.       registered owners.  These commands are:
  380.  
  381.            ^X^I Insert-file
  382.  
  383.             This command reads a text file from    disk and
  384.             inserts it into the    message    at the cursor.    If
  385.             EmacsDLG is    run from a local port (i.e. TL0) and
  386.             the    reqtools.library is installed, a file
  387.             requester will pop up to let you choose the    file
  388.             using the mouse.  Otherwise    EmacsDLG will prompt
  389.             for    the name of the    file.  In case you prefer
  390.             GNUemacs over MicroEmacs, you may use ^XI rather
  391.             than ^X^I.
  392.  
  393.             If ^X^I detects a non-ASCII    file, it will
  394.             automatically UUENCODE the file.  The UUENCODE
  395.             algorithm is built in to EmacsDLG so no external
  396.             program is necessary.
  397.  
  398.             Your users can use ^X^I to insert a    file from
  399.             their private file directory.  A typical use would
  400.             be to upload a file    to themselves, then use    ^X^I
  401.             to mail it to another user.
  402.  
  403.            ^X^W Write-file
  404.  
  405.             This command writes    the contents of    the message
  406.             buffer into    a disk file.  If EmacsDLG is run from
  407.             a local port (i.e. TL0) and    the reqtools.library
  408.             is installed, a file requester will    pop up to let
  409.             you    choose the file    using the mouse.  Otherwise
  410.             EmacsDLG will prompt for the name of the file.
  411.  
  412.            ^X^P Print-file
  413.  
  414.             This command prints    the message buffer to your
  415.             PRT: device.  The same access permissions as ^X^W
  416.             Write-file are used    for ^X^P Print-file.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.       EmacsDLG 1.6                       21-Oct-1994
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.                      - 7 -
  431.  
  432.  
  433.  
  434.       6.  CUSTOMIZATION WITH EMACSFIG
  435.  
  436.       The basic unregistered EmacsDLG program does not provide any
  437.       customization    options    for the    sysop.    However, the defaults
  438.       are adequate for most    BBS installations.  If you register
  439.       EmacsDLG, you    can use    the EmacsFIG Gadtools-based
  440.       configuration    program.  EmacsFIG will    let you    select colors,
  441.       language text, quote headers,    and many more options.
  442.  
  443.       Since    EmacsFIG uses GadTools as its user interface, you must
  444.       be running Workbench 2.0 or later to use it.    No support for
  445.       1.3 is planned.
  446.  
  447.       NOTE:    EmacsFIG will not load or save unless you have
  448.       registered.
  449.  
  450.       Run EmacsFIG in the directory    you specified on the EmacsDLG
  451.       command line when you    installed EmacsDLG.  EmacsFIG creates
  452.       a file named EmacsDLG.CFG that contains your customization
  453.       options.  Following are descriptions of each of the options
  454.       you may configure.
  455.  
  456.  
  457.       6.1  FILE READ ACCESS
  458.  
  459.       This defines the minimum access level    for the    ^X^I insert-
  460.       file command.     Any file on your system can be    read using
  461.       this command,    so it should be    available only to you and
  462.       possibly your    co-sysops.
  463.  
  464.  
  465.       6.2  FILE WRITE ACCESS
  466.  
  467.       This defines the minimum access level    for the    ^X^W write-
  468.       file command.     Any file on your system can be    written    using
  469.       this command,    so it should be    available only to you and
  470.       possibly your    co-sysops.
  471.  
  472.  
  473.       6.3  TAB WIDTH
  474.  
  475.       When the user    presses    the TAB    key, EmacsDLG inserts spaces
  476.       until    the next tab position is reached.  By default, the tab
  477.       stops    are set    to every 8 positions.
  478.  
  479.  
  480.       6.4  FORTUNE COOKIE COMMAND
  481.  
  482.       A fortune cookie is a    random comment,    phrase,    or joke    that
  483.       can be inserted at the end of    your message.  If enabled, the
  484.       fortune cookie will appear after your    message    text but
  485.       before your signature    (if any).
  486.  
  487.       EmacsDLG allows up to    twenty different fortune cookie
  488.       commands to be configured.  This lets    your users choose
  489.       different themes depending on    the message area they're
  490.  
  491.  
  492.  
  493.       EmacsDLG 1.6                       21-Oct-1994
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.                      - 8 -
  502.  
  503.  
  504.  
  505.       using, or on their mood.  For    example, you could setup
  506.       fortunes for Star Trek, Movie    Trivia,    Famous Quotes, Dead
  507.       Baby Jokes, or whatever.
  508.  
  509.       Click    the "New" gadget to create a new fortune cookie
  510.       command.  Enter the command and a brief description of the
  511.       command.  The    description is what the    users see when they
  512.       choose from multiple fortune commands, so say    something like
  513.       "Star    Trek quotes" as    your description.
  514.  
  515.       Click    the "Delete" gadget to delete the currently displayed
  516.       fortune cookie command, and click on "Next" to step through
  517.       all of the commands you have defined.
  518.  
  519.       To use fortune cookies, you must find    a suitable fortune
  520.       cookie command and tell EmacsDLG how to run it.  The basic
  521.       requirement is that it must write its    message    to standard
  522.       output with no ANSI codes.  You should keep fortunes limited
  523.       to one or two    lines to avoid the wrath of other sysops.
  524.  
  525.          - Mark Montminy's CRUMBS program is highly    recommended.
  526.            It includes options to limit the    chosen cookie to a
  527.            certain number of lines,    and to provide leading and
  528.            trailing    delimiters if you wish.     File request COOKIE
  529.            from 1:104/121 to get a copy of CRUMBS.
  530.  
  531.          - Here's a    reasonable setup for CRUMBS that limits
  532.            fortunes    to two lines, and puts three dots in front of
  533.            the fortune to make it stand out:
  534.  
  535.             dlg:utils/crumbs -l    2 -p ...
  536.  
  537.          - Several databases of fortunes are floating around the
  538.            DLG community, included the typical cookies, Star Trek
  539.            phrases,    and obscene fortunes.  You may also choose to
  540.            create a    database of your own fortunes, so that your
  541.            messages    have a more individualized appearance.    Mark
  542.            Montminy    is one source of fortune cookie    databases.
  543.            You can freq FORTUNES from his system, 1:323/119, to
  544.            get a few large databases that work with    CRUMBS.
  545.  
  546.       Enter    the fortune cookie command in the appropriate gadget
  547.       in EmacsFIG.    Do not use any file redirection.  Do not use
  548.       "run"    to execute the command.     The command should be found
  549.       in your CLI PATH, or you may specify the full    path of    the
  550.       command.
  551.  
  552.       The fortune cookie command line may contain any of the
  553.       normal DLG %variables.  These    will be    expanded and passed to
  554.       the fortune program, which may then do further processing.
  555.       This might be    used by    a combination fortune/signature
  556.       program to include the user's    name in    the generated fortune.
  557.       Note that this capability is meaningless if your fortune
  558.       cookie program does not use it.
  559.  
  560.  
  561.  
  562.  
  563.  
  564.       EmacsDLG 1.6                       21-Oct-1994
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.                      - 9 -
  573.  
  574.  
  575.  
  576.       By default, the fortune cookie will NOT be added to
  577.       messages.  To    get a cookie you must use the ESC-Z (user
  578.       customization) command from within EmacsDLG.    Any user who
  579.       wants    to use the fortune cookies must    do this.  They will
  580.       then have a choice of    three fortune cookie options:
  581.  
  582.          - Never append a cookie to    messages.  This    is the
  583.            default.
  584.  
  585.          - Ask if a    cookie should be used when the message is
  586.            saved.  In this mode, the chosen    cookie will appear in
  587.            the lower EmacsDLG window and you can choose whether or
  588.            not to use it.  If you don't like it, more cookies will
  589.            be chosen until you find    one you    like, or you give up.
  590.  
  591.          - Always append a cookie to messages.  In this mode,
  592.            EmacsDLG    will choose a cookie and append    it without
  593.            letting you preview the cookie.    This only works    if you
  594.            have defined exactly one    fortune    cookie command.     If
  595.            you define more than one, EmacsDLG will always ask.
  596.  
  597.       The user also    gets to    decide which of    the fortune cookie
  598.       topics is to be used as their    default.  They can specify one
  599.       to use, or they can have EmacsDLG ask    them each time they
  600.       save a message.
  601.  
  602.       Remember, to get a fortune cookie you    must configure it in
  603.       the user customization command.
  604.  
  605.  
  606.  
  607.       6.5  FILE REQUESTER DIRECTORY
  608.  
  609.       The ^X^I insert-file and ^X^W    write-file commands use    a file
  610.       requester.  You may specify the directory path to be
  611.       displayed the    first time the file requester is used.    The
  612.       default is RAM:.
  613.  
  614.  
  615.  
  616.       6.6  BROADCAST PORTS
  617.  
  618.       The ESC ! command can    be used    to send    a broadcast message to
  619.       another port.     This is useful    if you get a broadcast message
  620.       from another user, and you want to respond without leaving
  621.       the editor.  When ESC    ! is invoked, EmacsDLG shows a listing
  622.       of who is on-line, so    that you can direct your broadcast to
  623.       the correct port.  By    default, the port listing will show
  624.       TR0, TR1, and    TL0.
  625.  
  626.       Specify the ports you    want displayed in the BROADCAST    PORTS
  627.       gadget.  Type    all your ports together    as one string with no
  628.       blanks.  For example,    "TR0TR1TR2TR3TR4".
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.       EmacsDLG 1.6                       21-Oct-1994
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.                      - 10 -
  644.  
  645.  
  646.  
  647.       6.7  SPELLING    CHECKER    RUN COMMAND
  648.  
  649.       EmacsDLG uses    an external AREXX spelling checker.  If    you
  650.       wish EmacsDLG    to start the spelling checker program when a
  651.       user first invokes it, specify that command here.  Note that
  652.       you will most    likely want to use "RUN    >NIL: command" so that
  653.       the spelling checker is run in the background.  The
  654.       redirection to NIL: is necessary to prevent AmigaDOS from
  655.       writing the "[CLI n]"    message    to the user's screen.
  656.  
  657.       You may instead prefer to start the spelling checker in your
  658.       user-startup and leave it running all    the time.  If you wish
  659.       to do    this, enter a ";" semi-colon as    the spelling checker
  660.       run command.
  661.  
  662.       See the SPELLING CHECKER section later in this manual    for
  663.       details on how to configure specific spelling    checkers.  The
  664.       default setup    will work with Ispell.
  665.  
  666.  
  667.       6.8  SPELLING    CHECKER    AREXX PORT
  668.  
  669.       Enter    the name of the    AREXX port used    by your    spelling
  670.       checker.  The    default    setup will work    with Ispell.
  671.  
  672.  
  673.       6.9  SPELLING    CHECKER    CHECK COMMAND
  674.  
  675.       Enter    the AREXX command used by your spelling    checker    to
  676.       check    a work.     The spelling checker must respond in one of
  677.       the following    ways:
  678.  
  679.          - It should send a    result code of 1, with a secondary
  680.            result of "ok" or "bad" depending on whether or not the
  681.            word is spelled correctly.
  682.  
  683.          - It should send a    result code of 1 if the    word is
  684.            spelled correctly, or a result code of 0    if the word is
  685.            spelled incorrectly.
  686.  
  687.  
  688.       6.10    SPELLING CHECKER EXIT COMMAND
  689.  
  690.       Enter    the AREXX command that will cause your spelling
  691.       checker program to exit.  EmacsDLG will send this command
  692.       when the user    exits from EmacsDLG.  The default setup    works
  693.       with Ispell.
  694.  
  695.       You may prefer to leave your spelling    checker    running    at all
  696.       times.  If you wish to do this, enter    a ";" semi-colon as
  697.       the spelling checker exit command.
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.       EmacsDLG 1.6                       21-Oct-1994
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.                      - 11 -
  715.  
  716.  
  717.  
  718.       6.11    CUSTOM TEXT
  719.  
  720.       Many of the text messages displayed by EmacsDLG can be
  721.       customized.  The scrolling list contains a short description
  722.       of each text that can    be changed.  Click on the desired
  723.       description to cause the current value to be displayed in
  724.       the large gadget below the list.  Then click on the large
  725.       gadget to change the text as desired.
  726.  
  727.       Most of the text strings are obvious.     Several need more
  728.       explanation, and are described below.
  729.  
  730.  
  731.       6.12    QUOTE GREETING TEXT
  732.  
  733.       The "Quote Greeting" is inserted at the top of a quoted
  734.       message.  Several special codes are used to allow you    to
  735.       customize the    contents of the    quote greeting.     The permitted
  736.       codes    are listed below.  Please note that the    case of    each
  737.       code IS important.
  738.  
  739.       Your users may create    their own quote    greetings using    the
  740.       ESC-Z    command    (registered systems only).  One    a user has
  741.       saved    their settings with ESC-Z, they    get whatever quote
  742.       greeting was in effect at the    time they saved    it.  If    you
  743.       change it in EmacsFIG, those users will not get the new
  744.       quote    greeting.
  745.  
  746.       The following    codes may be used in the quote greeting:
  747.  
  748.           %F    The    full name of the original message author
  749.             (FROM).
  750.  
  751.           %f    The    first name of the original message author.
  752.  
  753.           %T    The    full name of the original message recipient
  754.             (TO).
  755.  
  756.           %S    The    subject    or title of the    quoted message.
  757.  
  758.           %q    The    quote attribution of the original message
  759.             author.  This will be either the initials or first
  760.             name, depending on how you have configured the
  761.             quote prefix in EmacsFIG.
  762.  
  763.           %d    The    date and time that the quoted message was
  764.             written.
  765.  
  766.           %N    A hard newline is inserted at this point.  You
  767.             normally will want to end your quote greeting with
  768.             a hard newline.
  769.  
  770.           %%    A single "%" is inserted at    this point.
  771.  
  772.       Here are some    useful examples:
  773.  
  774.  
  775.  
  776.  
  777.       EmacsDLG 1.6                       21-Oct-1994
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.                      - 12 -
  786.  
  787.  
  788.  
  789.            On %d %F    wrote about %S:%N
  790.  
  791.            Dear %f,%N%NYou recently    wrote the following message about
  792.            "%S" to %T:%N
  793.  
  794.            %F wrote    the lines marked "%q" in the following quote:%N
  795.  
  796.  
  797.  
  798.       6.13    YES/NO TEXT
  799.  
  800.       The "Input yes" and "Input no" text defines what your    user
  801.       will use to answer yes/no questions.    Specify    the entire
  802.       word.     EmacsDLG will recognize the first character as    the
  803.       value    typed by the user.
  804.  
  805.  
  806.       6.14    COLORS
  807.  
  808.       Click    on the gadget above the    color pallete to choose    which
  809.       color    you want to configure, then select the color from the
  810.       pallete.  The    preview    window shows you what your users will
  811.       see using the    standard IBM ANSI color    pallete.  Depending on
  812.       the terminal program in use, the 8 brighter colors may show
  813.       up as    bold text.
  814.  
  815.  
  816.       6.15    BORDER STYLE
  817.  
  818.       Click    on the Border Style gadget to change the way the
  819.       border between Emacs windows is displayed.  Choices include
  820.       a reverse bar, ANSI single and double    lines, and a variety
  821.       of ASCII characters.    Watch the preview window to see    the
  822.       results.  The    Reverse    Bar and    ASCII character    selections an
  823.       be displayed on any terminal,    while the The single and
  824.       double line selections require your users to use an IBM ANSI
  825.       character set.
  826.  
  827.  
  828.       6.16    QUOTE PREFIX
  829.  
  830.       One of the cycle gadgets lets    you choose the style of    quoted
  831.       lines.  You may select from the author's first name or
  832.       initials, and    the initials may be either upper or lower
  833.       case.     You may also choose a simple ">" if you would rather
  834.       not clutter your quotes with names or    initials.
  835.  
  836.  
  837.       6.17    SPECIAL    OPTIONS
  838.  
  839.       The Special Options list allows special customization    to be
  840.       done that is not specifically    supported by EmacsFIG.
  841.       Normally you will not    need to    use this list.    Watch for
  842.       messages on the DLG support echos for    special    circumstances
  843.       where    the Special Options may    be necessary.
  844.  
  845.  
  846.  
  847.  
  848.       EmacsDLG 1.6                       21-Oct-1994
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.                      - 13 -
  857.  
  858.  
  859.  
  860.       There    are ten    entries    in the Special Options list.  To add a
  861.       Special Option, click    on one of the blank entries in the
  862.       list,    then enter the value in    the gadget below the list.  To
  863.       remove one, click on the entry in the    list and then blank it
  864.       out in the gadget below the list.  Be    very careful when
  865.       entering Special Options.  If    you misspell an    option,    you
  866.       may cause EmacsDLG to    malfunction.
  867.  
  868.  
  869.       6.18    SPECIAL    WORD WRAP OPTION
  870.  
  871.       NOTE:    This is    available only in the ESC-Z per-user
  872.       customization    command    and cannot be set globally using
  873.       EmacsFIG.  Actually, there is    a way using the    SPECIAL
  874.       OPTIONS list,    but there really should    never be a need    to set
  875.       this option globally.
  876.  
  877.       The special word wrap    option causes EmacsDLG to
  878.       automatically    turn word wrap OFF whenever it is invoked with
  879.       a normal file.  Messages and file descriptions will always
  880.       have word wrap on by default.
  881.  
  882.       The reason for this option is    that some sysops like to use
  883.       EmacsDLG to remotely edit their configuration    files.    Word
  884.       wrapping must    be off when editing those files, else disaster
  885.       may ensue.  The only people likely to    set this option    are
  886.       those    sysops and co-sysops who regularly edit    configuration
  887.       files    remotely.
  888.  
  889.       Note that when this option is    set, word wrapping will    be
  890.       turned off when creating a DLG bulletin and when adding a
  891.       comment to a file description.  DLG provides no way for
  892.       EmacsDLG to determine    that these particular kinds of files
  893.       are being edited.  If    you turn this option on, you will want
  894.       to use ^XMW to manually turn on word wrapping    for those
  895.       kinds    of files.
  896.  
  897.       The default behavior for EmacsDLG is to always have word
  898.       wrapping on.
  899.  
  900.  
  901.  
  902.  
  903.       7.  THE SPELLING CHECKER
  904.  
  905.       EmacsDLG uses    AREXX to communicate with an external spelling
  906.       checker.  Any    spelling checker that supports a compatible
  907.       AREXX    interface will work.  EmacsDLG has been    tested with
  908.       ISpell version 3.3LJR, and RXSpell, an AREXX spelling
  909.       checker used by Xenolink.  Both ISpell and RXSpell are
  910.       freely distributable.
  911.  
  912.       NOTE:    The spelling checker works only    if EmacsDLG is
  913.       registered.
  914.  
  915.  
  916.  
  917.  
  918.  
  919.       EmacsDLG 1.6                       21-Oct-1994
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.                      - 14 -
  928.  
  929.  
  930.  
  931.       You can file request a compatible version of ISpell from
  932.       1:104/121 (14.4K Dual    Standard) using    the magic name ISPELL
  933.       (approximately 550K bytes).  You can also find ISpell    on
  934.       amiga.physik.unizh.ch    in the os2/util    directory as ispell-
  935.       3.3LJR.lzh.
  936.  
  937.       You can file request RXSpell from 1:104/121 by the magic
  938.       name RXSPELL (approximately 80K bytes).  RXSpell is smaller
  939.       and faster than ISpell, but knows fewer words.
  940.  
  941.  
  942.       7.1  SETUP
  943.  
  944.       You can setup    ISpell in either of two    ways.  The first way
  945.       will simply cause misspelled words to    be flagged, and    allows
  946.       the user to enter a replacment.  Specify the following
  947.       options in EmacsFIG:
  948.  
  949.       _____________________________________
  950.       |Spell run     run >nil: c:ispell -r |
  951.       |AREXX port     IRexxSpell           |
  952.       |Spell check     quickcheck           |
  953.       |Spell exit     exit               |
  954.       |____________________________________|
  955.  
  956.       The second way to use    ISpell is to have it provide a list of
  957.       suggested replacements for any misspelled word.  The user
  958.       can then enter the correct word from the list    of
  959.       suggestions, or supply their own word.  This is the
  960.       recommended setup.  Specify the following options in
  961.       EmacsFIG:
  962.  
  963.       _____________________________________
  964.       |Spell run     run >nil: c:ispell -r |
  965.       |AREXX port     IRexxSpell           |
  966.       |Spell check     check               |
  967.       |Spell exit     exit               |
  968.       |____________________________________|
  969.  
  970.       To use RXSpell, specify the following    options    in EmacsFIG:
  971.  
  972.       _______________________________________________________________
  973.       |Spell run     run >nil: doors:spell/rxspell doors:spell/dict. |
  974.       |AREXX port     SPELL                         |
  975.       |Spell check     CHECKWORD                     |
  976.       |Spell exit     QUIT                         |
  977.       |______________________________________________________________|
  978.  
  979.       IMPORTANT INFORMATION:  When you configure the spelling
  980.       checker for the first    time, you MUST use EmacsFIG and    SAVE
  981.       the result.  Even if you use the default values shown    in
  982.       EmacsFIG, those defaults will    only take effect if you    SAVE
  983.       them.
  984.  
  985.       My tests show    that ISpell uses about 700K of RAM, while
  986.       RXSpell only uses 70K    of RAM.     You may want to consider the
  987.  
  988.  
  989.  
  990.       EmacsDLG 1.6                       21-Oct-1994
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.                      - 15 -
  999.  
  1000.  
  1001.  
  1002.       RAM requirements in choosing which spelling checker to use.
  1003.  
  1004.  
  1005.       7.2  USING THE SPELLER
  1006.  
  1007.       To run the spelling checker on the current message, press
  1008.       ESC-C.  EmacsDLG will    interactively prompt for each
  1009.       misspelled word, asking you for a replacement.  If you
  1010.       choose to enter a replacement, the new word will be
  1011.       substituted for the old one.
  1012.  
  1013.       If ISpell has    been configured    correctly, EmacsDLG will pop
  1014.       up a window containing suggested replacments when a
  1015.       misspelled word is found.
  1016.  
  1017.  
  1018.  
  1019.  
  1020.       8.  HACK & SLASH MESSAGING INTEGRATION
  1021.  
  1022.       EmacsDLG can be invoked by Mark Montminy's Hack & Slash door
  1023.       game to edit messages    within the game.  The unregistered
  1024.       version of EmacsDLG will treat such messages as plain    files.
  1025.  
  1026.       The registered version of EmacsDLG treats Hack & Slash
  1027.       messages like    regular    messages.  The Hack & Slash alias of
  1028.       the message recipient    and subject will appear    at the top of
  1029.       the screen, and more importantly, the    quote commands work
  1030.       for quoting replies!
  1031.  
  1032.       Please contact me if you are the author of a door program
  1033.       and would like to have EmacsDLG integrated with your door.
  1034.  
  1035.  
  1036.  
  1037.  
  1038.       9.  TROUBLESHOOTING
  1039.  
  1040.       The most common problems with    EmacsDLG are caused by
  1041.       installing the files in the wrong places.  Please see    the
  1042.       INSTALLATION section for a list of file locations.  Note
  1043.       that you may also specify a directory    where all the EmacsDLG
  1044.       files    will live.  If you do it this way, everything except
  1045.       the registration key file go in this directory.
  1046.  
  1047.       When running EmacsFIG, ALWAYS    remember to CD to the
  1048.       directory where your EmacsDLG.CFG file lives.     Otherwise it
  1049.       will create a    new one, and since the new one is in the wrong
  1050.       directory, EmacsDLG won't find your settings.
  1051.  
  1052.       When upgrading to a new version of EmacsDLG, registered
  1053.       users    should always run EmacsFIG and SAVE the    results.  This
  1054.       guarantees that your EmacsDLG.CFG file is up to date with
  1055.       the latest version.
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.       EmacsDLG 1.6                       21-Oct-1994
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.                      - 16 -
  1070.  
  1071.  
  1072.  
  1073.       If you get "Spelling checker not installed", you have    either
  1074.       misspelled the name of the AREXX port    for the    spelling
  1075.       checker, or your EmacsDLG.CFG    file is    in the wrong
  1076.       directory.
  1077.  
  1078.       If you get "No response from spelling    checker", most likely
  1079.       your spelling    checker    command    string is incorrect.
  1080.  
  1081.       The spelling checker may return an error number.  If the
  1082.       number is greater than zero, it is an    AREXX error that you
  1083.       can look up in your AREXX manual.  Negative numbers indicate
  1084.       weird    internal problems and should be    reported to the
  1085.       author.
  1086.  
  1087.       If you get an    empty fortune, it's a bug in CRUMBS. :-)
  1088.  
  1089.       If a user has    used the ESC-Z command to customize their
  1090.       editing environment, all of the customizable options are
  1091.       saved.  If you later make a global change using EmacsFIG,
  1092.       the change will be seen only by users    who have not used
  1093.       ESC-Z.
  1094.  
  1095.       Here's the general sequence of activities when EmacsDLG
  1096.       starts up.  This may help you    in figuring out    why something
  1097.       is misbehaving.  You might try running SnoopDos is something
  1098.       is misbehaving.
  1099.  
  1100.         1.    Read the user's    User.Data file.
  1101.  
  1102.         2.    Read the EmacsDLG.CFG file to get the sysop-customized
  1103.         options.  If unregistered, a set of built-in defaults
  1104.         are used instead.
  1105.  
  1106.         3.    Read the user's    EmacsDLG.opt file to get user-
  1107.         customized options.  All options specified here
  1108.         override the sysop-customized options.    If
  1109.         unregistered, no user options are available.
  1110.  
  1111.         4.    Read in    the file to be edited, if any.
  1112.  
  1113.         5.    The first time a quote command is used,    the quoted
  1114.         message    is read    in and formatted.
  1115.  
  1116.         6.    The first time the user    requests help, the
  1117.         EmacsDLG.HLP file is loaded into memory.  Subsequent
  1118.         help requests use the in-memory    copy.
  1119.  
  1120.       The ESC-Z command for    registered users works as follows:
  1121.  
  1122.         1.    Load the EmacsOpts program, passing to it the options
  1123.         that are currently in effect.
  1124.  
  1125.         2.    If the user aborts their changes, EmacsOpts exits.
  1126.  
  1127.         3.    If the user save their changes,    EmacsOpts writes the
  1128.         EmacsDLG.OPT file in the user's    home directory,    and
  1129.  
  1130.  
  1131.  
  1132.       EmacsDLG 1.6                       21-Oct-1994
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140.                      - 17 -
  1141.  
  1142.  
  1143.  
  1144.         then exits.
  1145.  
  1146.         4.    After EmacsOpts    exits, EmacsDLG    reads the EmacsDLG.OPT
  1147.         file to    make the new options take effect.  If a
  1148.         message    has already been quoted, the new quoting
  1149.         options    will not take effect until the next time
  1150.         EmacsDLG is run.
  1151.  
  1152.  
  1153.  
  1154.  
  1155.       10.  BUG REPORTS
  1156.  
  1157.       Please post bug reports and feature requests to the DLG_DEV
  1158.       echo,    or send    netmail    to me at 1:104/121.  Always include
  1159.       the EmacsDLG version number you are running, and your
  1160.       Kickstart and    Workbench version numbers.  Requests for new
  1161.       features will    be treated more    seriously from registered
  1162.       users.
  1163.  
  1164.  
  1165.  
  1166.  
  1167.       11.  HOW TO REGISTER
  1168.  
  1169.       See the enclosed REGISTER.TXT    file for details on how    to
  1170.       register for your EmacsDLG extensions.
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.       EmacsDLG 1.6                       21-Oct-1994
  1204.  
  1205.  
  1206.  
  1207.  
  1208.